home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / FROMUTS / ARC100 / !Arc100 / !ReadMe next >
Text File  |  1991-01-03  |  10KB  |  220 lines
  1. Documentation for Arc100 Beta-Test 2.2 - a PD VT100 Terminal Emulator
  2. ---------------------------------------------------------------------
  3.  
  4. All code and documentation is the exclusive copyright of Richard K. Lloyd,
  5. but it may be freely distributed and is completely in the Public Domain.
  6.  
  7. ATTENTION !
  8.  
  9. Although this program has (finally) been released into the Public Domain,
  10. it is strictly beta-test and may contain some minor flaws. The author accepts
  11. no responsibility if these flaws cause any problems for the user whatsoever.
  12. Please report any problems/bugs to the address at the end of this document -
  13. XON/XOFF at high baud rates is suspect at the moment...apologies for this.
  14.  
  15. Introduction
  16. ------------
  17.  
  18. Arc100 is a VT100 terminal emulator I wrote a while ago and never released
  19. into the PD because RISC OS caused it to stop handling XON-XOFF correctly.
  20. I finally corrected this during the Christmas 1990 break - I tracked it down
  21. to the event vector routine I had written taking too long to flash the custom
  22. cursor :-)
  23.  
  24. Supplied Features of Arc100
  25. ---------------------------
  26.  
  27. * Complete custom character set (8 by 10 pixels) 'turbo-poked' onto the screen
  28. * Intelligent buffering - does not display characters until there is a break
  29.   in the transmission or a cursor movement occurs
  30. * On-screen clock showing current time or elapsed connect time
  31. * 132-column mode (SET TERM/WIDTH=132 in VAX/VMS performs a spectacular mode
  32.   change - most other VT100 emulators simply clear the screen)
  33. * Four speeds of scrolling (1,2,5 or 10 pixels at a time)
  34. * Double-height/double-width characters
  35. * Knows all the 'funnies' used by full-screen editors such as VAX/VMS's EDT
  36. * Custom variable-width cursor
  37. * Point-and-click with the mouse to move the cursor
  38. * Individual tab setting allowed
  39. * Custom dialogue box system - auto-scales in 132-column mode
  40. * Exit to the Desktop and re-entry into the emulator by clicking on its icon
  41.   again returns to it in exactly the same state as it was left
  42.  
  43. How to Use Arc100
  44. -----------------
  45.  
  46. The application installs an icon bar icon when double-clicked. This simply
  47. has the standard Info and Quit options and needs no further explanation.
  48. Clicking on the icon bar icon with the left or right buttons will enter the
  49. emulator (or re-enter where you left it). Arc100 takes over the whole screen
  50. in MODE 12 (or MODE 16 for 132-column mode) and hence I did not bother
  51. making the code multi-tasking. The other reason is because high-speed on-screen
  52. poking is performed for most operations - this is infeasible with windowed
  53. multi-tasking programs.
  54.  
  55. The status line at the bottom of the screen ("Line 25") displays the following:
  56.  
  57. * Four LEDs simulating VT100 LEDs 1 to 4. Clicking on them will toggle their
  58.   status, as will sending the appropriate escape sequence.
  59.  
  60. * VT100/VT52 mode indicator. Clicking on this will toggle between VT100 and
  61.   VT52 emulation.
  62.  
  63. * Online/Local indicator. Again, click to toggle. "Online" mode means that the
  64.   host must generate characters to be displayed, whereas "Local" means that
  65.   you may type locally and the characters are displayed and not sent to the
  66.   host (and any characters generated by the host are ignored). "Local" mode
  67.   is very useful for testing certain escape sequences (try ESC # 8).
  68.  
  69. * Cursor X,Y position. Can be handy in some circumstances (especially dreaded
  70.   IBM mainframes !).
  71.  
  72. * Setup. Clicking on this will bring up a very self-explanatory dialogue box
  73.   (Setup 1) with options in it to jump to further boxes (Setup 2 and Setup 3).
  74.  
  75. * Reset. Clicking on this will reset the terminal to the settings immediately
  76.   after the last save or load of the setup file. Unlike some other terminal
  77.   emulators, this does NOT involve a re-load of the settings from disk.
  78.  
  79. * Exit. Clicking on this will return you to the Desktop, BUT you can return
  80.   to exactly the same position (including intact screen text) by simply
  81.   clicking on the icon bar icon again.
  82.  
  83. * Program version string. Click on this for a version dialogue box containing
  84.   RS423 transmit/receive figures too. This facility is omitted (due to lack
  85.   of space) in the 132 column mode.
  86.  
  87. * Clock. Can display nothing at all, the current time or the elapsed connect
  88.   time (the later can be reset by simply clicking on the timer).
  89.  
  90. Saving the Setup
  91. ----------------
  92.  
  93. There is an option in the Setup 1 dialogue box to load the setup and also an
  94. option in Setup 2 to save it. Please note that the setup will NOT be loaded
  95. when Arc100 is first run and installed on the icon bar. It only loads when
  96. the icon bar icon is clicked on for the very first time, so floppy users
  97. should not remove the disk with Arc100 on until the icon bar icon has been
  98. clicked on to enter the emulator. You may add a saved setup filename to the
  99. end of the execution line in the !Run (the default is <Arc100$Dir>.!TermSetup),
  100. but Arc100 does not have its own filetype for these setup files. You may
  101. execute the !RunImage binary with a -help qualifier to get a page of slightly
  102. useful information.
  103.  
  104. Other Special Bits
  105. ------------------
  106.  
  107. The numeric keypad acts identically to a VT100 keypad. Num Lock / * and #
  108. behave as PF1 to PF4 (as do, incidentally, the function keys f1 to f4).
  109. Break on its own sends a short break, whereas Alt-Break sends a long one.
  110. Home locally homes the cursor and Shift-Home locally clears the screen as
  111. well as homing the cursor.
  112.  
  113. IntelliMouse System
  114. -------------------
  115.  
  116. This is an intuitive method of moving the cursor (in Online or Local mode)
  117. using the cursor keys or the mouse. If the mouse is clicked on a character
  118. cell, then the cursor will move to that position (or directly in Local mode).
  119. It does this by sending up/down sequences to the host first (and abandoning
  120. this if the cursor never reaches that line - some editors have a scrolling area
  121. which defeats this) and then left/right sequences afterwards. The cursor keys
  122. also have their intuitive meanings: Shift-Left or Shift-Right skip to the end
  123. of the word and Ctrl-Left or Ctrl-Right go to the appropriate edge of the line.
  124.  
  125. Technical Section
  126. -----------------
  127.  
  128. Arc100 is written ENTIRELY in ARM code and has been 'file-protected' to avoid
  129. tampering. The source code exceeds 250K and has not been supplied with this
  130. PD release. I used a Plessey PT100 (plus the manual) to test out my theories
  131. to the limit - the PD 'vttest' C program was also quite a help.
  132.  
  133. No, I'm not stupid enough to use a second screen buffer to save the screen
  134. between invocations - the character plotting routines are quick enough to
  135. allow redraw from a character grid in memory. The whole application needs only
  136. a 48K WimpSlot (plus 136K screen space of course for MODEs 12 and 16).
  137.  
  138. Known Problems with Arc100 Beta-Test 2.2
  139. ----------------------------------------
  140.  
  141. * When the cursor is over a bold character, the character should be visible
  142.   in some form of reverse video, but the palette messes this up and the
  143.   character becomes almost invisible...
  144.  
  145. * XON-XOFF code rehash has not been fully tested yet - may be suspect under
  146.   extreme circumstances.
  147.  
  148. Missing Features of Arc100 Beta-Test 2.2
  149. ----------------------------------------
  150.  
  151. * New RISC OS baud rates (e.g. 110 baud). Should really allow receive and
  152.   transmit rates to be set separately.
  153.  
  154. * File transfer protocols. Should permit ASCII transfer at the very least.
  155.  
  156. * Printer support. I'm sceptical about this because most people would probably
  157.   prefer to transfer the files up (and print them on the host) or down (and
  158.   print them on the Archimedes). Besides, have you ever seen a printer that
  159.   does a full VT100 emulation ? :-) Better would be a simple session logging
  160.   facility.
  161.  
  162. * Tektronix graphics. Also sceptical here, but if enough people demand it, then
  163.   I might consider it.
  164.  
  165. * Multi-tasking support. Fat chance of this considering the design of
  166.   the program. There's no way I'm sacrificing the speed of the emulator :-)
  167.  
  168. * OSCLI support. An easy one to add, but one open to abuse (e.g. running
  169.   new applications or, even worse, memory editors).
  170.  
  171. Revision History
  172. ----------------
  173.  
  174.    Beta-Test Releases
  175.    ------------------
  176.  
  177.    Version 2.2 (January 1991)
  178.  
  179.    First PD release, but not 100% perfect yet. I've been at the code for
  180.    over 2 years now (on-and-off of course) and it's about my biggest
  181.    project ever. XON-XOFF still unstable. Plenty of code tweaks everywhere.
  182.    Fixed function key problem (wasn't restoring properly on exit to Desktop)
  183.    and also made the Desktop exit/re-entry smoother (only changes MODE if
  184.    it has to).
  185.  
  186.    Version 2.1 (December 1989)
  187.  
  188.    Worked prior to RISC OS, but RISC OS's XON-XOFF support doesn't like long
  189.    event routines (mine flashed a cursor), so this version dropped more
  190.    characters than an episode of Dallas :-) Added RISC OS support in the form
  191.    of an Info Window and menu, plus the ability to exit and re-enter the
  192.    emulator exactly as you left it.
  193.  
  194.    Version 2.0 (mid-1989)
  195.  
  196.    Added an incredibly fast section to the character output routine. If a
  197.    completely plain character is plotted, then pre-expanded characters are
  198.    blitted straight onto the screen - providing a 4-fold increase in speed !
  199.  
  200.    Version 1.0 (mid-1988)
  201.  
  202.    Sick to death with the lack of a DECENT VT100 terminal emulator for use
  203.    with VAX/VMS, so slaved for a solid month to get an Arthur 1.20 version
  204.    of Arc100 working. Just a straightforward Absolute application with pretty
  205.    characters (understatement of the year there !).
  206.  
  207. Where to report bugs or suggest enhancements
  208. --------------------------------------------
  209.  
  210. Sorry to hog the source code to myself, but it's been my baby for a long, long
  211. time and I'm not ready to put it up for adoption (or should that be adaption ?)
  212. yet :-) Maybe sometime in the future when it stabilises (1995 ?).
  213.  
  214. Post Office Mail: Richard K. Lloyd,     JANET e-mail: rkl@uk.ac.liv.cs.and
  215.                   1, Banks Road,
  216.                   Lower Heswall,
  217.                   Wirral,
  218.                   Merseyside.
  219.                   L60 9JS
  220.